pp108 : GetCase Variables

GetCase Variables

This API is used to retrieve all the Case variables of the specific Case instance.

Resource URI
v1/cases/{modelid}/instances/{caseInstanceId}/variables
Request Type

HTTP GET

HTTP Header Parameters

Parameter

Description

Accepted Input Values

SAMLart

 The SAML artifact received after authentication. Refer to Login for more information on how to authenticate.

Note: The supported output formats are:

  • JSON
  • XML
Request Parameters
Parameter Description Accepted Input Values

modelid

 The model ID of the Case. For example, if the model ID qname is com/opentext/conference/ProductLaunch then in the URL it must be provided as com.opentext.conference.ProductLaunch.

caseInstanceId

 The instance ID of the Case instance.  
Response Parameters

Parameter

Description

case_data

Contains the Case data associated with the Case model. The Case variables will be a part of the Case data.

data

Data is the placeholder of the content specified by its name attribute. In this case, data refers to the Case variables.

casevariables

The Case variables serve as the container for all the Case identifiers defined for a given Case model. Each child element of the casevariables element represents a Case variable. The name of the Case variable is the name of the element differentiated by its type.
Sample Response
<GetCaseVariablesResponse>
    <case_instance_id>5f15319f-1b44-11e3-e955-fa8c8a9a9d41</case_instance_id>
    <case_data lockID="e3181184-e8da-11e3-e96b-576fd88c5d7c">
        <data name="casevariables">
            <casevariables>
                <cv1 type="string">Manager</cv1>
                <cv2 type="string">Sales</cv2>
            </casevariables>
        </data>
    </case_data>
</GetCaseVariablesResponse>